3
3
.
.
2
2
.
.
1
1
L
L
o
o
g
g
S
S
t
t
a
a
r
r
t
t
E
E
n
n
d
d
I
I
n
n
f
f
o
o
[
[
G
G
]
]
[
[
R
R
]
]
This tutorial shows how to use AOP Annotation to Log Method's Execution Time.
Application Schema [Result]
Spring Boot Starters
GROUP
DEPENDENCY
DESCRIPTION
Web
Spring Web
Enables: Controller Annotations, Tomcat Server
P
P
r
r
o
o
c
c
e
e
d
d
u
u
r
r
e
e
Create Project: springboot_aop_logging (add Spring Boot Starters from the table)
Edit File: pom.xml (add AOP dependency)
Create Package: log (inside main package)
– Create Class: LogStartEnd.java (inside log package)
– Create Class: LogStartEndAspect.java (inside log package)
Create Package: controllers (inside main package)
– Create Class: MyController.java (inside controllers package)
pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
LogStartEnd.java
package com.ivoronline.springboot_aop_log_startend.log;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogStartEnd { }
http://localhost:8080/Hello
Tomcat
hello()
MyController
@LogStartEnd
LogStartEndAspect
LogStartEndAspect.java
package com.ivoronline.springboot_aop_log_startend.log;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
@Aspect
@Component
public class LogStartEndAspect {
@Around("@annotation(LogStartEnd)")
public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
//GET METHOD PARAMETERS
String methodName = joinPoint.getSignature().getName(); //hello
String className = joinPoint.getSignature().getDeclaringType().getSimpleName(); //MyController
//EXECUTE BEFORE METHOD
System.out.println("STARTED METHOD: " + className + "." + methodName + "()");
//EXECUTE METHOD
Object proceed = joinPoint.proceed();
//EXECUTE AFTER METHOD
System.out.println("ENDED METHOD: " + className + "." + methodName + "()");
//RETURN METHOD RESULT
return proceed;
}
}
MyController.java
import com.ivoronline.springboot_aop_log_startend.log.LogStartEnd;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class MyController {
@LogStartEnd
@ResponseBody
@RequestMapping("/Hello")
public String hello() {
return "Hello from Controller";
}
}
R
R
e
e
s
s
u
u
l
l
t
t
http://localhost:8080/Hello
Console
STARTED METHOD: MyController.hello()
ENDED METHOD: MyController.hello()
Run Test Class: PersonTest
pom.xml
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
</dependencies>